You are here: AgileShapes > Premier Extension > Query Database

Query Database

This AgileShape can be used to execute dynamic SQL statements and/or call database stored procedures in order to retrieve data from the database.

 

NOTE: This AgileShape is a specialized sub-type of the AgilePart AgileShape. Refer to the documentation for the AgilePart AgileShape for additional information about the properties and behavior that this sub-type inherits from the AgilePart AgileShape.

 

Design-Time Properties

NOTE: Since this AgileShape is a specialized sub-type of the AgilePart AgileShape, all of the standard properties supported by the AgilePart AgileShape are also supported by this AgileShape. Since they are already documented elsewhere, the standard AgilePart properties are not documented in this section. Refer to the documentation for the AgilePart AgileShape for information about the standard AgilePart properties. Additional design-time properties (other than the standard AgilePart properties) that are specific to this AgileShape are documented below.

 

Configure

This property allows the process modeler to configure where and how the data is retrieved from the database.

NOTE: Changes made to this property’s configuration may also update the values of the ConnectionString, and/or SQL properties.

 

Click the Ellipses button to open the configuration dialog.

 

Below is a sample configuration:

 

 

 

ConnectionString

NOTE: This property can only be updated via the Configure property. See that property for additional information. The connection string that will be used to connect to the database at runtime.

 

DatabaseType

The type of database that will be used.

 

Debug

Default value: True

This property determines whether the AgileShape will log additional progress and debugging messages to the AgilePoint Server log file at runtime. This property can be set to the following specific values:

 

SQLType

Default value: SQL

This property determines whether this AgileShape will retrieve the data from the database using a database stored procedure, or using (one or more) dynamic SQL statements. This property can be set to the following specific values:


If the SqlType property is set to SQL when you click the Ellipses button, it will open a configuration dialog like the one shown below.

 

 

Clicking the Add button from this dialog will allow you to enter a dynamic SQL statement, and the name of the custom process attribute that the statement’s return value should be stored in.

 

 

StoredProcedure Mode:

If the SqlType property is set to StoredProcedure when you click the button, it will open a configuration dialog like the one shown below.

 

 

StoredProcedureName

NOTE: This property is ignored unless the SqlType property is set to StoredProcedure.

NOTE: This property can only be updated via the Configure property. See that property for additional information.

 

The name of the database stored procedure that will be executed by this AgileShape at runtime.

 

Timeout

Default value: 600

Specifies the maximum amount of time (in seconds) that should be allowed for the completion of the Web service call associated with this AgileShape.